<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="ids_v1.html">Cloud IDS API</a> . <a href="ids_v1.projects.html">projects</a> . <a href="ids_v1.projects.locations.html">locations</a> . <a href="ids_v1.projects.locations.endpoints.html">endpoints</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(parent, body=None, endpointId=None, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new Endpoint in a given project and location.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a single Endpoint.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of a single Endpoint.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Endpoints in a given project and location.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the parameters of a single Endpoint.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(parent, body=None, endpointId=None, requestId=None, x__xgafv=None)</code>
  <pre>Creates a new Endpoint in a given project and location.

Args:
  parent: string, Required. The endpoint&#x27;s parent. (required)
  body: object, The request body.
    The object takes the form of:

{ # Endpoint describes a single IDS endpoint. It defines a forwarding rule to which packets can be sent for IDS inspection.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The create time timestamp.
  &quot;description&quot;: &quot;A String&quot;, # User-provided description of the endpoint
  &quot;endpointForwardingRule&quot;: &quot;A String&quot;, # Output only. The fully qualified URL of the endpoint&#x27;s ILB Forwarding Rule.
  &quot;endpointIp&quot;: &quot;A String&quot;, # Output only. The IP address of the IDS Endpoint&#x27;s ILB.
  &quot;labels&quot;: { # The labels of the endpoint.
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;name&quot;: &quot;A String&quot;, # Output only. The name of the endpoint.
  &quot;network&quot;: &quot;A String&quot;, # Required. The fully qualified URL of the network to which the IDS Endpoint is attached.
  &quot;satisfiesPzi&quot;: True or False, # Output only. [Output Only] Reserved for future use.
  &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
  &quot;severity&quot;: &quot;A String&quot;, # Required. Lowest threat severity that this endpoint will alert on.
  &quot;state&quot;: &quot;A String&quot;, # Output only. Current state of the endpoint.
  &quot;threatExceptions&quot;: [ # List of threat IDs to be excepted from generating alerts.
    &quot;A String&quot;,
  ],
  &quot;trafficLogs&quot;: True or False, # Whether the endpoint should report traffic logs in addition to threat logs.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The update time timestamp.
}

  endpointId: string, Required. The endpoint identifier. This will be part of the endpoint&#x27;s resource name. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. Values that do not match this pattern will trigger an INVALID_ARGUMENT error.
  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, requestId=None, x__xgafv=None)</code>
  <pre>Deletes a single Endpoint.

Args:
  name: string, Required. The name of the endpoint to delete. (required)
  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Gets details of a single Endpoint.

Args:
  name: string, Required. The name of the endpoint to retrieve. Format: projects/{project}/locations/{location}/endpoints/{endpoint} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Endpoint describes a single IDS endpoint. It defines a forwarding rule to which packets can be sent for IDS inspection.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The create time timestamp.
  &quot;description&quot;: &quot;A String&quot;, # User-provided description of the endpoint
  &quot;endpointForwardingRule&quot;: &quot;A String&quot;, # Output only. The fully qualified URL of the endpoint&#x27;s ILB Forwarding Rule.
  &quot;endpointIp&quot;: &quot;A String&quot;, # Output only. The IP address of the IDS Endpoint&#x27;s ILB.
  &quot;labels&quot;: { # The labels of the endpoint.
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;name&quot;: &quot;A String&quot;, # Output only. The name of the endpoint.
  &quot;network&quot;: &quot;A String&quot;, # Required. The fully qualified URL of the network to which the IDS Endpoint is attached.
  &quot;satisfiesPzi&quot;: True or False, # Output only. [Output Only] Reserved for future use.
  &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
  &quot;severity&quot;: &quot;A String&quot;, # Required. Lowest threat severity that this endpoint will alert on.
  &quot;state&quot;: &quot;A String&quot;, # Output only. Current state of the endpoint.
  &quot;threatExceptions&quot;: [ # List of threat IDs to be excepted from generating alerts.
    &quot;A String&quot;,
  ],
  &quot;trafficLogs&quot;: True or False, # Whether the endpoint should report traffic logs in addition to threat logs.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The update time timestamp.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists Endpoints in a given project and location.

Args:
  parent: string, Required. The parent, which owns this collection of endpoints. (required)
  filter: string, Optional. The filter expression, following the syntax outlined in https://google.aip.dev/160.
  orderBy: string, Optional. One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.
  pageSize: integer, Optional. The maximum number of endpoints to return. The service may return fewer than this value.
  pageToken: string, Optional. A page token, received from a previous `ListEndpoints` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEndpoints` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  &quot;endpoints&quot;: [ # The list of endpoints response.
    { # Endpoint describes a single IDS endpoint. It defines a forwarding rule to which packets can be sent for IDS inspection.
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. The create time timestamp.
      &quot;description&quot;: &quot;A String&quot;, # User-provided description of the endpoint
      &quot;endpointForwardingRule&quot;: &quot;A String&quot;, # Output only. The fully qualified URL of the endpoint&#x27;s ILB Forwarding Rule.
      &quot;endpointIp&quot;: &quot;A String&quot;, # Output only. The IP address of the IDS Endpoint&#x27;s ILB.
      &quot;labels&quot;: { # The labels of the endpoint.
        &quot;a_key&quot;: &quot;A String&quot;,
      },
      &quot;name&quot;: &quot;A String&quot;, # Output only. The name of the endpoint.
      &quot;network&quot;: &quot;A String&quot;, # Required. The fully qualified URL of the network to which the IDS Endpoint is attached.
      &quot;satisfiesPzi&quot;: True or False, # Output only. [Output Only] Reserved for future use.
      &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
      &quot;severity&quot;: &quot;A String&quot;, # Required. Lowest threat severity that this endpoint will alert on.
      &quot;state&quot;: &quot;A String&quot;, # Output only. Current state of the endpoint.
      &quot;threatExceptions&quot;: [ # List of threat IDs to be excepted from generating alerts.
        &quot;A String&quot;,
      ],
      &quot;trafficLogs&quot;: True or False, # Whether the endpoint should report traffic logs in addition to threat logs.
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The update time timestamp.
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  &quot;unreachable&quot;: [ # Locations that could not be reached.
    &quot;A String&quot;,
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</code>
  <pre>Updates the parameters of a single Endpoint.

Args:
  name: string, Output only. The name of the endpoint. (required)
  body: object, The request body.
    The object takes the form of:

{ # Endpoint describes a single IDS endpoint. It defines a forwarding rule to which packets can be sent for IDS inspection.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The create time timestamp.
  &quot;description&quot;: &quot;A String&quot;, # User-provided description of the endpoint
  &quot;endpointForwardingRule&quot;: &quot;A String&quot;, # Output only. The fully qualified URL of the endpoint&#x27;s ILB Forwarding Rule.
  &quot;endpointIp&quot;: &quot;A String&quot;, # Output only. The IP address of the IDS Endpoint&#x27;s ILB.
  &quot;labels&quot;: { # The labels of the endpoint.
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;name&quot;: &quot;A String&quot;, # Output only. The name of the endpoint.
  &quot;network&quot;: &quot;A String&quot;, # Required. The fully qualified URL of the network to which the IDS Endpoint is attached.
  &quot;satisfiesPzi&quot;: True or False, # Output only. [Output Only] Reserved for future use.
  &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
  &quot;severity&quot;: &quot;A String&quot;, # Required. Lowest threat severity that this endpoint will alert on.
  &quot;state&quot;: &quot;A String&quot;, # Output only. Current state of the endpoint.
  &quot;threatExceptions&quot;: [ # List of threat IDs to be excepted from generating alerts.
    &quot;A String&quot;,
  ],
  &quot;trafficLogs&quot;: True or False, # Whether the endpoint should report traffic logs in addition to threat logs.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The update time timestamp.
}

  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
  updateMask: string, Field mask is used to specify the fields to be overwritten in the Endpoint resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

</body></html>